/* Copyright 2022 The DeepRec Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/

// An optimization passes that marks nodes that are to be executed with
// attribute kCudaGraphModeAttr. Nodes with the same cluster ID will be executed
// together.

#ifndef TENSORFLOW_COMPILER_JIT_MARK_FOR_CUDA_GRAPH_MODE_PASS_H_
#define TENSORFLOW_COMPILER_JIT_MARK_FOR_CUDA_GRAPH_MODE_PASS_H_

#include "absl/container/flat_hash_set.h"

#include "tensorflow/compiler/jit/compilability_check_util.h"
#include "tensorflow/core/common_runtime/optimization_registry.h"

namespace tensorflow {

// The attribute that marks nodes to be grouped into functions by the
// encapsulate subgraphs pass.
extern const char* const kCGModeClusterAttr;

// Pass that marks a subset of operators in the graph with attribute
// _GraphMode so they are executed by graph mode engine.
class MarkForCudaGraphModePass : public GraphOptimizationPass {
 public:
  MarkForCudaGraphModePass() = default;

  Status Run(const GraphOptimizationPassOptions& options) override;

 private:
  Status RunForTest(const GraphOptimizationPassOptions& options,
                    bool disable_deadness_analysis);

  friend class MarkForCudaGraphModePassTestHelper;
};

namespace testing {
// DO NOT USE IN PRODUCTION.
//
// Resets some internal state to let us write reliable unit tests.
void ResetClusterSequenceNumber();

}  // namespace testing
}  // namespace tensorflow

#endif  // TENSORFLOW_COMPILER_JIT_MARK_FOR_CUDA_GRAPH_MODE_PASS_H_
